Hides an application’s floating windows.

OSStatus HideFloatingWindows ();

function result

A result code. Returns errFloatingWindowsNotInitialized (-5609) if you have not called InitFloatingWindows prior to HideFloatingWindows; otherwise, returns noErr (0).

DISCUSSION

When your application receives a suspend event, it must hide any visible floating windows. When your application receives a resume event, it must make its floating windows visible again.

You must call the function InitFloatingWindows prior to calling HideFloatingWindows.

See also the function ShowFloatingWindows.

SPECIAL CONSIDERATIONS

The HideFloatingWindows function operates only upon windows created with the kFloatingWindowClass constant; see “Window Class Constants” for more details on this constant.

VERSION NOTES

This function is supported with Mac OS 8.6 and later.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when WindowsLib 8.5 or later is installed. Exported by CarbonLib 1.0 and later and by WindowsLib 8.5 and later.

© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)